Fixed typos in Enter-PSSession -UserName parameter description#12878
Fixed typos in Enter-PSSession -UserName parameter description#12878sdwheeler merged 3 commits intoMicrosoftDocs:mainfrom
Conversation
Fixed spelling "uou" -> "you" and hyphenated "key based" -> "key-based"
dodexahedron
requested review from
michaeltlombardi and
sdwheeler
as code owners
There was a problem hiding this comment.
Pull request overview
This PR corrects minor wording issues in the Enter-PSSession documentation for the -UserName parameter in the PowerShell 7.6 reference docs.
Changes:
- Fixes a typo (
uou→you) in the-UserNameparameter description. - Hyphenates “key based” to “key-based” for consistent phrasing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit aa5cab0: ✅ Validation status: passed
For more details, please refer to the build report. |
|
I just took a look at the New-PSSession command too, since I figured it might have the same typos. It does not, and the text is slightly different. Seems to me these two commands should use the same text for this parameter, whatever that ends up being. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 22d320d: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 6bad886: ✅ Validation status: passed
For more details, please refer to the build report. |
@dodexahedron Thanks for the edits and feedback. I changed the wording to be more general about authentication. I think this is all we need to say about it in this context. |
PR Summary
Fixed spelling "uou" -> "you" and hyphenated "key based" -> "key-based" in the UserName parameter description of the Enter-PSSession cmdlet.
Although I also have some commentary about this parameter's description, for the part where it talks about ssh behaviors:
passwordandpublickeyare not the only two possibilitiespublickey, if it appears more than once in a sequence, requires that each key be unique (ie you cannot use the same key twice)The point of all that is that, in my opinion, the part of the description talking about ssh behavior seems out-of-scope for this document.
Even if it's desirable to be there for convenience, it should probably not be so absolute in its wording, at least about the sentence I fixed in this PR.
For instance, if the server has
AuthenticationMethodsset topublickey,passwordorpassword,publickeyor any other sequence containing both, you will, in fact, be prompted for password when you have supplied a key.And then there are other options, like kerberos, which openssh supports and which behaves more like publickey from a user perspective, and is also not exclusive of the others.
The only invariant is that, if you supply a username, it overrides the default username presented to the server.
I'll put that into an issue if y'all prefer, and if y'all think it's worth addressing with more than a simple edit (like just deleting that text).
PR Checklist
RTG